/*******************************************************************************
 * Copyright (c) 2000, 2003 FUJITSU LIMITED and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     FUJITSU LIMITED - initial implementation
 *******************************************************************************/

package org.eclipse.cobol.ui.common.text;

import org.eclipse.jface.text.rules.IWordDetector;

/**
 * This interface is used by WordDetector by which <code>WordRule</code>
 * determines whether a given character is valid as part of a word or start of a
 * word in the current context.
 * 
 * @version 1.1
 * @author Fujitsu
 */
public interface ICOBOLWordDetector extends IWordDetector
{

	/**
	 * The Column number to identify Program identification Area beginning.
	 */
	public final static int FIXED_PID_AREA_BEGIN = 66;

	/**
	 * The Varaiable format pid area begin
	 */
	public final static int VARIABLE_PID_AREA = 245;

	/**
	 * Returns whether the specified character is valid as the first character
	 * in a word based on the column.
	 * 
	 * @param character character to be checked
	 * @param column position of the character
	 * @return true if the character is valid as a start of the word
	 */
	public boolean isWordStart(char character, int column);

	/**
	 * Returns whether the specified character is valid as a subsequent
	 * character in a word based on the column.
	 * 
	 * @param character character to be checked
	 * @param column position of the character
	 * @return true if the character is valid as a part of the word
	 */
	public boolean isWordPart(char character, int column);

}
